home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / edit / smed21.zip / MANUAL.TXT < prev    next >
Text File  |  1995-09-07  |  19KB  |  412 lines
  1. ****************************
  2. *                          *
  3. *        MANUAL.TXT        *
  4. *                          *
  5. ****************************
  6. * Manual for Smooth Editor *
  7. ****************************
  8.  
  9. for version 2.1
  10.  
  11. Contents:
  12. ---------
  13. Chapter 1. Introduction to Smooth Editor.
  14. Chapter 2. Installing Smooth Editor.
  15. Chapter 3. Using Smooth Editor.
  16. Chapter 4. Scrolling and moving.
  17. Chapter 5. Block functions.
  18. Chapter 6. Macro's.
  19. Chapter 7. Wrapping.
  20. Chapter 8. SE.INI settings.
  21. Chapter 9. Menu functions.
  22. Chapter10. Keyboard functions.
  23.  
  24.  
  25.  
  26. Chapter 1. Introduction to Smooth Editor
  27. ----------------------------------------
  28.  
  29. Smooth Editor is a DOS text editor with FAST smooth scrolling and complete 
  30. Windows(R) interface. Smooth scrolling is a way of moving text over the screen 
  31. with a speed that is synchronized with the frequency at which the image is 
  32. built on the screen. For instance with VGA video cards, the screen image is 
  33. refreshed 70 times per second. If the image on screen is moved one pixel every 
  34. 1/70th of a second, what we see is an absolutely fluid motion. Smooth Editor 
  35. uses horizontal and vertical smooth and smoothly accelerated scrolling.
  36.  
  37. The Windows interface makes it possible to use cut/copy/paste from and to 
  38. Windows applications, to use drag/drop from the file manager and to have 
  39. Smooth Editor close down like other applications under Windows, with a save 
  40. file query if necessary, when you exit Windows. For more information about the 
  41. Windows interface, see the SEWIN.TXT file.
  42.  
  43. SE also has virtually unlimited file lengts, undo and redo functions, macros, 
  44. multiple documents open, symbol table, wordwrap functions, bookmarks, find and 
  45. replace functions, scrolling and color customization, command line switches, 
  46. text viewing mode etc.
  47.  
  48. Smooth Editor is released under the Shareware concept. For more information 
  49. see REGISTER.TXT.
  50.  
  51.  
  52.  
  53. Chapter 2. Installing Smooth Editor
  54. -----------------------------------
  55.  
  56. To use Smooth Editor you need a PC with:
  57. - 80386 processor or higher.
  58. - VGA video card or higher.
  59.  
  60. For editing large files you need:
  61. - At least 370 kB of free conventional memory.
  62. - Extended memory.
  63. - An XMS-driver (like HIMEM or QEMM).
  64.  
  65. To install Smooth editor, you can copy the SE.EXE program to a directory that 
  66. is part of the Path (that is mentioned after the PATH statement in the 
  67. AUTOEXEC.BAT). Or, if you use DOSKEY you can include it in a DOSKEY macro, for 
  68. instance with this instruction in the AUTOEXEC.BAT:
  69.  
  70. DOSKEY SE=C:\SE\SE.EXE $*
  71.  
  72. For using Smooth Editor under Windows, see the SEWIN.TXT file.
  73.  
  74. If you use Smooth Editor from the command line within a DOS-box under Windows 
  75. and you have a number of applications running, you may experience stuttering 
  76. scrolling. To solve this you can close down the DOS-box (using the `EXIT' 
  77. command), set the Execution: Exclusive checkbox in the DOSPRMPT.PIF and start 
  78. a new DOS-box.
  79.  
  80.  
  81.  
  82. Chapter 3. Using Smooth Editor
  83. ------------------------------
  84.  
  85. When you first start up Smooth editor, you will be asked whether you would 
  86. like to see the demo. This demo demonstrates a number of functions. If you 
  87. want to see this demo again later, delete the SE.INI file before you start SE.
  88.  
  89. To start up SE you use: SE [filename(s)] [/v][/e][/s][/n][/t][/i][/w][/l]
  90.  
  91. Filenames: Up to ten file names. Wildcards (* and ?) are allowed. All
  92.            corresponding files will be opened.
  93. /v  View mode. For viewing text files without editing.
  94. /e  Edit mode. This mode is default. Opposite of View mode.
  95. /s  Smooth Scrolling. This mode is default.
  96. /n  No Smooth Scrolling.
  97. /t  Tab Repeat. With this mode Enter will copy opening tabulators and 
  98. indents from previous line (useful for instance for programming with indents)
  99. /i  Individual tabs (no Tab Repeat). This is the default mode.
  100. /w  Word Wrap. When typing long lines will be split without splitting words.
  101. /l  Long lines (no Word Wrap). This is the default mode.
  102. /1  This will fix jittered scrolling on slow computers.
  103.  
  104. These command line switches will override SE.INI settings.
  105.  
  106. Smooth Editor will then start up with the File Open window. If you want to 
  107. start with a new file you can press the Escape key to exit this window.
  108.  
  109. What you see now is an empty screen with one line of information at the 
  110. bottom. This is the status line. On the left, it shows the file name. Next to 
  111. that the flags are shown (at startup this displays: `Esc: Menu F1: Help'. When 
  112. any key is pressed this will change into the flags), five three letter 
  113. abbreviations that indicate the state of the program. When a flag is white it 
  114. indicates that that state is on, when it is dark gray it means that it is off. 
  115. The five flags are:
  116.  
  117. - MOD : Modified, this indicates that the file has been altered since the last 
  118.     load or save.
  119. - INS : Insert mode. Typing is inserted at the cursor position.
  120. - OVR : Overwrite mode. Typing overwrites the text under the cursor. The 
  121.     Insert button switches between insert and overwrite mode.
  122. - CLB : Data present in Clipboard (from Cut or Copy).
  123. - WRP : WordWrap mode (see menu option WordWrap).
  124.  
  125. On the right side of the status line four numbers are displayed:
  126.  
  127. S:xx : Indicates current scroll speed in lines per frame.
  128. C:xxx : Current Column. 
  129. L: xxxx/ xxxx: Current Line / Total number of lines in the current file.
  130.  
  131. In Smooth Editor you can use the Escape or Alt buttons to enter the menu. In 
  132. the menu you can use the arrow keys and the Enter key to navigate through the 
  133. items. You can also use the character keys to move to the items with those 
  134. characters highlighted.
  135.  
  136. Many functions in Smooth Editor can be called with more than one key. This is 
  137. done, so that if you are used to different hotkeys, you can use SE without 
  138. having to learn new keys.
  139.  
  140. To exit SE for instance, you can use F12, Alt+F4, Ctrl+q, Alt+x or use the 
  141. menu option with ALT+F,X.
  142.  
  143. You can get online help with the F1 key.
  144.  
  145. Every change to the document can be undone with Ctrl+Z, Ctrl+U or the Undo 
  146. menu option with Alt+E,U. By repeatedly undoing you can trace back all your 
  147. steps. The MOD (Modified) flag is updated when you undo, so you can see when 
  148. the file is in the original state again. After you undo changes you can redo 
  149. them with Ctrl+Shift+Z or the Redo menu option with Alt+E,R. Undo and Redo are 
  150. both limited to 32 kB of data.
  151.  
  152. Scroll speeds and color usage are set in the SE.INI file. When SE starts up, 
  153. it checks the directory where SE.EXE is located for SE.INI. If it is not there 
  154. SE will look for it in the path (that is mentioned after the PATH statement in 
  155. the AUTOEXEC.BAT). If it is still not found SE will ask to create a new SE.INI 
  156. in the directory where SE.EXE is located. In this file all parameters will be 
  157. set to their default values.
  158.  
  159. In the COLORS.TXT file there are a couple of premade color configurations. You 
  160. can copy these and paste them over the color settings in SE.INI.
  161.  
  162. Other than standard characters can be inserted by typing Alt+0 or Alt+[code]. 
  163. A window will appear with all possible characters. You can choose a character 
  164. by typing it's code or by moving the blue cursor to it.
  165.  
  166. If the 'Tab repeat' option in the Settings menu is enabled and you press enter 
  167. on a line that starts with an indent (spaces) or a tabulator, these will be 
  168. copied to the next lines.
  169.  
  170.  
  171.  
  172. Chapter 4. Scrolling and moving
  173. -------------------------------
  174.  
  175. Smooth Scrolling can be disabled or enabled with the 'Toggle Smoothscrolling' 
  176. option in the Settings menu, with the Smoothscrolling setting in the SE.INI 
  177. file or with the command line options.
  178.  
  179. The following keys are used for scrolling and moving through the file:
  180. With the arrow keys, the cursor can be moved through the text. The text 
  181. scrolls when necessary.
  182.  
  183. The PageUp and PageDown keys can be used in two ways. When they are tipped 
  184. shortly the text scrolls one page quickly with smooth acceleration and 
  185. deceleration. When they are kept down the acceleration stops at a lower speed.
  186.  
  187. When the Ctrl key is kept down, the Arrow up and down keys accelerate the text 
  188. scrolling. In this way you can control the scrolling speed. With the Ctrl key 
  189. kept down, the PageUp and PageDown key accelerate the text scrolling at a 
  190. faster rate.
  191.  
  192. Ctrl+arrow right and Ctrl+arrow left move the cursor to the next / previous 
  193. word, scrolling when necessary. Ctrl+Home moves to the beginning of the text, 
  194. Ctrl+End moves to the end.
  195.  
  196. The scroll speeds can be changed by editing SE.INI.
  197.  
  198.  
  199.  
  200. Chapter 5. Block functions
  201. --------------------------
  202.  
  203. When the position of the cursor changes with the shift key pressed, the text 
  204. between the old and the new cursor position will be selected. This is 
  205. indicated by the fact that this text becomes inverted.
  206.  
  207. With the menu function Cut, or the keys Ctrl+X or Shift+Delete the selected 
  208. text will be copied to the clipboard and deleted from the text. The CLB flag 
  209. at the bottom of the screen will turn white to indicate that there is 
  210. information on the clipboard.
  211.  
  212. With the menu function Copy, or the keys Ctrl+C or Ctrl+Insert the selection 
  213. will only be copied to the clipboard.
  214.  
  215. If the functions Cut and Copy are used when there's no selection, the whole 
  216. current line will be cut or copied.
  217.  
  218. With the menu function Paste, or the keys Ctrl+V or Shift+Insert the text on 
  219. the clipboard will be copied to the cursor position. If there is a selection 
  220. this text will be overwritten, otherwise it will be inserted before the cursor 
  221. position.
  222.  
  223. If the Delete key is pressed while there is a selection, the selection will be 
  224. deleted.
  225.  
  226. Ctrl + -(minus key) types a character from the previous sentence.
  227.  
  228. F9 copies the current line. F10 cuts the current line. F11 pastes before the 
  229. current line.
  230.  
  231.  
  232.  
  233. Chapter 6. Macros
  234. -----------------
  235.  
  236. In Smooth Editor you can record, name, save and playback macros. The kind of 
  237. macros Smooth Editor has are keystroke recordings. This means that when you 
  238. record a macro, every keystroke that takes place is registered. When this 
  239. macro is played back these keystrokes will be executed in quick succession, 
  240. independent of what these keystrokes do. For instance, while recording, you 
  241. can use the Find menu option and edit the Search string and press enter. You 
  242. have to remember that when the macro is executed, the previous Search string 
  243. will appear in the Find window. Since Smooth Editor will only dumbly execute 
  244. the keystrokes, it could go wrong if you haven't anticipated this. During 
  245. macro recording and playback Smooth Scrolling is disabled.
  246.  
  247. With Shift+F1..F10 recording starts on macro 1..10. This can also be done by 
  248. using the Macro menu options in the Edit menu or Ctrl+M and selecting the 
  249. macro you want to record. After you execute the keystrokes you want to record 
  250. you press F1 to end recording. Smooth Editor will prompt you for the name for 
  251. this macro. This name will appear in the Macro menu when you want to execute 
  252. the macro. If you want to you can save the current macros by selecting the 
  253. Save option in the Macro window (this window is opened by the Macros option in 
  254. the Edit menu or the Ctrl+m key). If you don't save it, you will be prompted 
  255. that there are unsaved macros when you exit the program. To execute a macro 
  256. you can use Ctrl+F1..F10 or select Play in the macro window.
  257.  
  258.  
  259.  
  260. Chapter 7. Wrapping
  261. -------------------
  262.  
  263. Wordwrapping is the function that when a line is longer than 80 characters, 
  264. part of it is moved to the next line. When a document is loaded into the 
  265. program all lines end in 'hard returns'. This means that the program treats 
  266. every line like a seperate paragraph. For instance if wordwrap mode is on and 
  267. text is inserted in a line, so that the line becomes longer than 80 
  268. characters, an empty line is created after this one and the last word on this 
  269. line will be moved to the new line. If this happens, the first line ends in a 
  270. 'soft return'. If some more text is inserted in this line, so that it becomes 
  271. longer than 80 characters again, the last word moves to the next line instead 
  272. of creating a new line. Also if a line ends in a 'soft return' and it is 
  273. shortened enough for the first word on the line to fit on the screen after the 
  274. first line, it is moved there.
  275.  
  276. The 'Wrap doc/selection' option in the Settings menu splits all lines longer 
  277. than 80 characters in the (selected part of) the document. The program will 
  278. only ask if it should justify the whole document or the selection if there is 
  279. a selection.
  280.  
  281. The 'Justify doc/selection' option will do the same but will also join lines 
  282. that are shorter than 80 characters. It will replace all the 'hard returns' 
  283. with 'soft returns' unless the following line is empty or starts with a 
  284. summation character (- or *).
  285.     
  286. The Toggle WordWrap function will enable or disable wordwrap. The initial mode 
  287. for wordwarp (enabled or disabled) can be set in SE.INI or with a command line 
  288. option.
  289.  
  290.  
  291. Chapter 8. SE.INI settings
  292. --------------------------
  293.  
  294. The SE.INI file contains settings for Smooth Editor. It is loaded when SE 
  295. starts up. Command line options override SE.INI settings. When SE doesn't find 
  296. a SE.INI file it suggests to create one with all settings on default. The 
  297. SE.INI file Smooth Editor creates contains explanation for all settings in it. 
  298. The color settings are made up of two sections. There is the pallette, in 
  299. which you create all the colors you want to have available in the program. 
  300. These are specified in a red value, a green value and a blue value, all 
  301. ranging from 0-63. For instance bright white is 63,63,63, black is 0,0,0, 
  302. bright red is 63,0,0.
  303. You also have to specify where to use which color. This is done in the 
  304. Color... settings.
  305.  
  306. In the COLORS.TXT file there are a couple of premade color configurations. You 
  307. can copy these and paste them over the color settings in SE.INI.
  308.  
  309.  
  310. Chapter 9. Menu functions
  311. -------------------------
  312.  
  313. File menu ------- New           -Starts with new file, the old file is still in 
  314.                    memory
  315.        ------ Open        -Opens the File Open Window. Here you can 
  316.                                navigate through the directories and choose a 
  317.                    file you want to edit.
  318.         ----- Save        -Save current file.
  319.          ---- Save As     -Opens the File Save Window.
  320.               --- Print          -Prints current file. If there is a selection 
  321.                    you will be asked if you want to print the 
  322.                    selection or the whole file.
  323.            -- Edit SE.INI -Opens the file SE.INI for editing. In it you 
  324.                   can change the scrolling speeds and the color 
  325.                    usage.
  326.         - Exit          -Quits SE and returns to the OS (for instance 
  327.                    DOS).
  328.  
  329. Edit menu --------- Undo       -Undoes last action.
  330.        -------- Redo       -Undoes last undo.
  331.         ------- Cut        -Cuts selection or line.
  332.          ------ Copy       -Copies selection or line.
  333.           ----- Paste      -Pastes over selection or before cursor 
  334.                 position.         
  335.            ---- Clear      -Deletes selection.
  336.         --- Select All -Selects whole file.
  337.          -- Symbol     -Opens the symbol table window. With it you can 
  338.                 insert any character.
  339.                   - Macro      -Opens the Macro window.
  340.  
  341.  
  342. Settings menu ------ Wrap doc/selection      -Splits all long lines in 
  343.                           document or selection.
  344.            ----- Justify doc/selection   -Splits long lines and joins 
  345.                                               short lines in document or 
  346.                                               selection
  347.         ---- Toggle Wordwrap         -Disables/enables wordwrap
  348.                  --- Toggle Tab repeat       -With Tab repeat on, when you 
  349.                                               press enter on a line that 
  350.                                               starts with an indent (spaces) 
  351.                                               or a tabulator, these will be 
  352.                                               copied to the next lines.
  353.           -- Toggle Smooth Scrolling -Disables/enables smoothscrolling
  354.            - Toggle View/Edit mode   -In View mode there is no cursor  
  355.                                               and it is not possible to change 
  356.                           the document.
  357.  
  358.  
  359. Search ----- Find          -The program will ask for a search string. It will 
  360.                 then search the document from the cursor for that 
  361.                 string.
  362.         ---- Find Previous -Searches from the cursor upward for the last 
  363.                 entered search string.
  364.          --- Find Next     -Searches from the cursor downward for the last
  365.                             entered search string.
  366.       -- Replace       -Finds and replaces a search string.
  367.        - Bookmarks       -Enters the Bookmark Window.
  368.  
  369.  
  370. Help menu -- Help          -Shows three screen of useful information.
  371.        - About         -Shows some information about Smooth Editor.
  372.  
  373.  
  374.  
  375. Chapter 10. Keyboard functions
  376. -----------------------------
  377.  
  378. Escape, Alt            : Enters menu.
  379. F12,Alt+F4,Ctrl+q,Alt+x: Exit Smooth Editor.
  380. F1                     : This on-line help.
  381. Alt+<Number>           : Insert symbol, by number or from table.
  382. Ctrl+Z, Ctrl+U         : Undo. Undo levels limited only by 32k buffer.
  383. Ctrl+Shift+Z           : Redo. Redo levels limited only by 32k buffer.
  384.  
  385. PageUp, PageDown       : - Only tipped shortly: A quick one-page scroll.
  386.                          - Sustained          : Scroll with constant speed.
  387. Ctrl + Up,Down         : Accelerate scroll slowly.
  388. Ctrl + PageUp,PageDown : Accelerate scroll fast.
  389.                         (With this accelerated scrolling the cursor position
  390.                          does not change until it reaches the screen border.
  391.                          Scrolling stops when Ctrl is released.)
  392. Ctrl + Right,Left      : Move to next/previous word.
  393. Ctrl + Home,End        : Move to begin/end of file.
  394.  
  395. Shift+ cursor movement : Selection.
  396. Ctrl+X, Shift+Delete   : - With selection   : Cut selection.
  397.                          - Without selection: Cut current line.
  398. Ctrl+C, Ctrl+Insert    : - With selection   : Copy selection.
  399.                          - Without selection: Copy current line.
  400. Ctrl+V, Shift+Insert   : - With selection   : Paste, overwriting selection.
  401.                          - Without selection: Paste before cursor position.
  402. Delete(with selection) : Delete selection.
  403. Ctrl + - (minus key)   : Type from previous line.
  404.  
  405. Shift + F1..F10        : Record macro 1..10
  406. Ctrl + F1..F10        : Play macro 1..10
  407.  
  408. Other key combination are mentioned in the menu functions between square 
  409. brackets.
  410.  
  411.  
  412. Windows is a registered trademark of Microsoft Corporation.